docs: Make badges consistent, run markdownlint on all .md files #109
Conversation
- Consistently generate badges for GH workflows in README RHELPLAN-146921 - Run markdownlint on all .md files - Add custom-woke-action if not used already - Rename woke action to Woke for a pretty badge Signed-off-by: Sergei Petrosian <[email protected]>
spetrosi
force-pushed
the
update_role_files
branch
from
4f86fac
to
ee0fc1b
Compare
|  | ||
| [](https://github.com/linux-system-roles/ssh/actions/workflows/ansible-ubuntu.yml) | ||
| [](https://github.com/linux-system-roles/ssh/actions/workflows/ansible-debian.yml) | ||
| [](https://github.com/linux-system-roles/ssh/actions/workflows/ansible-debian.yml) [](https://github.com/linux-system-roles/ssh/actions/workflows/ansible-lint.yml) [](https://github.com/linux-system-roles/ssh/actions/workflows/ansible-test.yml) [](https://github.com/linux-system-roles/ssh/actions/workflows/ansible-ubuntu.yml) [](https://github.com/linux-system-roles/ssh/actions/workflows/shellcheck.yml) [](https://github.com/linux-system-roles/ssh/actions/workflows/markdownlint.yml) [](https://github.com/linux-system-roles/ssh/actions/workflows/woke.yml) |
There was a problem hiding this comment.
whats the advantage of listing all the badges on a single line? Such long lines are hard to read/display in most of the editors and diffs are even harder to spot.
I initially placed them on separate lines as the Markdown merges them to a single line anyway and it is easier to track changes in them when they are on separate lines.
There was a problem hiding this comment.
The advantage is to generate them in .github, see https://github.com/linux-system-roles/.github/pull/42/files#diff-99e99bac7991cbf3337188c9f34cc45e998346d41ab9467aeea9406ad2654572R163
Doing this multi-line will be much harder. And given that there is automation, no need to maintain this line manually.
There was a problem hiding this comment.
Thanks for clarification! It was not sure to me on the first couple of reads through the changes here.
There was a problem hiding this comment.
It is nasty, yeah. There are spaces between badges to distinguish between them. Automation helps very much here.
Signed-off-by: Sergei Petrosian <[email protected]>
Signed-off-by: Sergei Petrosian [email protected]